home *** CD-ROM | disk | FTP | other *** search
/ Total Web Page (Professional Suite) / Total Web Page 99.iso / CGI / DOWNLOAD.CGI-S=WWWBOARD&C=TXT&F=README < prev    next >
Text File  |  1996-06-03  |  15KB  |  314 lines
  1. ##############################################################################
  2. # WWWBoard                      Version 2.0 ALPHA 2                          #
  3. # Copyright 1996 Matt Wright    mattw@worldwidemart.com                      #
  4. # Created 10/21/95              Last Modified 11/25/95                       #
  5. # Scripts Archive at:           http://www.worldwidemart.com/scripts/        #
  6. ##############################################################################
  7. # If you run into any problems while trying to configure this scripts, help  #
  8. # is available.  The steps you should take to get the fastest results, are:  #
  9. #       1) Read this file thoroughly                         #
  10. #       2) Consult the Matt's Script Archive Frequently Asked Questions:     #
  11. #               http://www.worldwidemart.com/scripts/faq/                 #
  12. #       3) If you are still having difficulty installing this script, send   #
  13. #          e-mail to: scripts-help@tahoenet.com                     #
  14. #          Include any error messages you are receiving and as much detail   #
  15. #          as you can so we can spot your problem.  Also include the variable#
  16. #          configuration block that is located at the top of the script.     #
  17. #                                         #
  18. # Hopefully we will be able to help you solve your problems.  Thank you.     #
  19. ##############################################################################
  20. # COPYRIGHT NOTICE                                                           #
  21. # Copyright 1996 Matthew M. Wright  All Rights Reserved.                     #
  22. #                                                                            #
  23. # WWWBoard may be used and modified free of charge by anyone so long as      #
  24. # this copyright notice and the comments above remain intact.  By using this #
  25. # code you agree to indemnify Matthew M. Wright from any liability that      #  
  26. # might arise from it's use.                                                 #  
  27. #                                                                            #
  28. # Selling the code for this program without prior written consent is         #
  29. # expressly forbidden.  In other words, please ask first before you try and  #
  30. # make money off of my program.                                              #
  31. #                                                                            #
  32. # Obtain permission before redistributing this software over the Internet or #
  33. # in any other medium.  In all cases copyright and header must remain intact.#
  34. ##############################################################################
  35.  
  36. WWWBoard is the Version 2.0 of my Bulletin Board Message System.  I think 
  37. that the name is much better, and a lot fewer characters.  Version 2.0 
  38. has many enhancements, which were never put into version 1.0.  MANY of 
  39. the bugs in version 1.0 were fixed, although I am sure you will probably 
  40. find more.  
  41.  
  42. This version of the message system is a complete re-write over the last 
  43. one, and is not at all backwards compatible.  To use this new version, 
  44. you will just need to remove all past messages and start again.  I think 
  45. it is definitely worth it.
  46.  
  47. WWWBoard Version 2.0 has managed to reduce the number of scripts required 
  48. to run the bulletin board from three down t one.  This makes it much more 
  49. efficient.
  50.  
  51. The following files should have come with WWWBoard Version 2.0 ALPHA 2:
  52.  
  53.         a.  ALPHA-2       - READ THIS.
  54.     1.  README      - The necessary Install Instructions.  This file.
  55.     2.  wwwboard.pl   - The Perl CGI script that runs everything.
  56.     3.  wwwboard.html - The HTML WWWBoard file that users will see.
  57.     4.  faq.html      - An FAQ file displayed for users of wwwboard.
  58.     5.  data.txt      - Where the file number is stored.
  59.     6.  messages/      - Where the messages will be created and stored.
  60.     7.  wwwadmin.pl      - An Admin tool to delete messages.
  61.     8.  passwd.txt    - The encoded password and username for WWWAdmin
  62.         9.  ADMIN_README  - WWWAdmin README file.
  63.  
  64. You will need to edit by hand several of the files that come with 
  65. WWWBoard Version 2.0.  Below is a description of how to modify all of the 
  66. necessary files:
  67. ___________________________________________________________________________
  68.  
  69.                 WWWBOARD.PL
  70.                 ===========
  71.  
  72. This file must be placed in your server's cgi-bin, or if your server has 
  73. .cgi extensions allowed, you can simply rename this file to wwwboard.cgi, 
  74. changing the $cgi_url variable below to reflect this.  The file must also 
  75. be chmoded 755. Ask your system administrator for more information on 
  76. either the cgi-bin or chmod command.
  77.  
  78. This is the most complicated file you will need to modify.  It comes with 
  79. a lot of variables and many options.  Below is a summary of how to 
  80. configure all of the variables and what the options do:
  81.  
  82. ###########################################################################
  83. # Define Variables
  84.  
  85. $basedir = "/path/to/wwwboard";
  86.     This variable should contain the absolute system path to your     
  87.         wwwboard directory.  So if you keep all of your files in     
  88.         /home/yourname/public_html and you make a directory under there
  89.         called 'wwwboard', then $basedir would be set to: 
  90.         /home/yourname/public_html/wwwboard.
  91.  
  92. $baseurl = "http://your.host.xxx/wwwboard";
  93.         This is the base URL to the directory where wwwboard is kept.  So
  94.      staying with the example above, if your main directory is called 
  95.         by: http://your.host.xxx/~yourname/, the $baseurl would be set to: 
  96.         http://your.host.xxx/~yourname/wwwboard/.
  97.  
  98. $cgi_url = "http://your.host.xxx/cgi-bin/wwwboard.pl";
  99.     This is the URL that points to wwwboard.pl.  This will be used in 
  100.         followup form responses, so this must be correct.
  101.  
  102. $mesgdir = "messages";
  103.     This is the name of your messages directory which will be appended
  104.      to $basedir.  All of the messages for wwwboard will be created and
  105.      held in this directory.
  106.  
  107. $datafile = "data.txt";
  108.     This is the name of the data file which will also be appended to 
  109.         $basedir.  It will hold the current filename count, and the script 
  110.         will read this in and determine the message filename from this     file.
  111.  
  112. $mesgfile = "wwwboard.html";
  113.     This is the name of the wwwboard.html file, which you might want to
  114.      rename to index.html for the sake of a shorter URL.  It will be 
  115.         appended to both $basedir and $baseurl to determine the URL and the 
  116.         absolute path to this file, both for URL references by the script 
  117.         and for editing of this file by the script.
  118.  
  119. $faqfile = "faq.html";
  120.     This is the path to the faq.html file which will be appended to 
  121.         $baseurl so users can find their way to the Frequently Asked
  122.      Questions file about WWWBoard.
  123.  
  124. $ext = "html";
  125.     This is the ext with which all individual files will be created 
  126.         with.  Most of the time it should be left as html, but on the 
  127.     occasion when you may be suing this on a dos based platform you can
  128.      switch it to 'htm'.
  129.  
  130. $date_command = "/bin/date";
  131.     This needs to be the path to your 'date' command.  This script uses
  132.      the date command to time stamp the messages individually with along
  133.      date and to place a short 'added' date on the wwwboard.html page.
  134.  
  135. $title = "WWWBoard Version 2.0 Test";
  136.     This is the title of your WWWBoard, which will be used on the 
  137.         individual message pages.  Call your message board whatever you 
  138.         like, but I do recommend changing the above to something a little 
  139.         more catchy. :-)
  140.  
  141. # Done
  142. ###########################################################################
  143.  
  144. There are also several options you will need to configure:
  145.  
  146. ###########################################################################
  147. # Configure Options
  148.  
  149. $show_faq = 1;          # 1 - YES; 0 = NO
  150.     This option allows you to choose whether or not you want to display
  151.      a link to the FAQ on every individual message page or not.  It
  152.      defaults to 1 and the link will be put in at the top of the message
  153.      along with links to Followups, Post Followup and Back to $title.
  154.       Setting this to 0 will turn it off, and keeping it at 1 will keep
  155.      the link.
  156.  
  157. $allow_html = 1;        # 1 = YES; 0 = NO
  158.     This option lets you choose whether or not you want to allow HTML 
  159.     mark-up in your posts.  If you do not want to allow it, then
  160.      everything that a user submits that has <>'s around it will be cut 
  161.     out of the message.  Setting this option to '1' will allow HTML in 
  162.     the posts and you can turn this option off by setting it to '0'.
  163.  
  164. $quote_text = 1;        # 1 = YES; 0 = NO
  165.     By keeping this option set to 1, the previous message will be 
  166.     quoted in the followup text input box.  The quoted text will have a 
  167.     ':' placed in front of it so you can distinguish what had been said 
  168.     in the previous posts from what the current poster is trying to get 
  169.     across.  Setting this option to '0' will leave the followup text 
  170.     box empty for the new poster.
  171.  
  172. $subject_line = 0;      # 0 = Quote Subject Editable; 1 = Quote Subject
  173.                         #   UnEditable; 2 = Don't Quote Subject, Editable.
  174.     There are three options for the way that you can display the 
  175.     subject line for the user posting a followup.  Leaving this option 
  176.     at '0' which is the default value, will put the previous subject 
  177.     line into the followup form and allow users to edit the subject 
  178.     however they like.  Setting this option to '1', however, will quote 
  179.     the subject, but simply display it to the user, not allowing him or 
  180.     her to edit the subject line.  The third and final option can be 
  181.     achieved by setting the $subject_line variable to '2'.  If it is 
  182.     set to '2' the subject will not be quoted and instead the user will 
  183.     be prompted with an empty subject block in their followup subject 
  184.     line.
  185.  
  186. $use_time = 1;        # 1 = YES; 0 = NO
  187.     This option allows you to choose whether or not you want to use the
  188.      hour:minute:second time with the day/month/year time on the main 
  189.     page.  Day/Month/Year will automatically be placed on the main 
  190.     wwwboard.html page when a new entry is added, but if you leave this 
  191.     variable at '1' the hour:minute:second time will also be put there. 
  192.     This is very useful for message boards that get a lot of posts, 
  193.     but if you would like to save space on your main page, you can set 
  194.     this to '0' causing the hour:minute:second display not to be added.
  195.  
  196. # Done
  197. ###########################################################################
  198.  
  199. WOW!  You made it through all that.  That was the hardest file to edit.
  200.  
  201. ___________________________________________________________________________
  202.  
  203.                WWWBOARD.HTML
  204.                =============
  205.  
  206. wwwboard.html must be placed in the directory that you defined in 
  207. $basedir of your wwwboard.pl file.  It must be chmoded 777 so that your 
  208. web server's uid (User ID) has permission to write to this file.
  209.  
  210. This file needs much less editing than the wwwboard.pl script.  There are 
  211. three things that you will want to edit in this file.  The first two are 
  212. simply the title of your WWWBoard.  Currently the two lines look like:
  213.  
  214. <title>WWWBoard Version 2.0!</title> and <h1>WWWBoard Version 2.0!</h1>
  215.  
  216. You will want to change the title and header "WWWBoard Version 2.0!" to 
  217. whatever you want to call your WWWBoard.  This should probably be the 
  218. same as the variable $title that you defined in wwwboard.pl.
  219.  
  220. The third line in this file that you will need to edit is the one that 
  221. looks like:
  222.  
  223. <form method=POST action="http://your.host.xxx/cgi-bin/wwwboard.pl">
  224.  
  225. You need to change the URL that is in action="" to the same URL that you 
  226. defined in wwwboard.pl as $cgi_url.
  227.  
  228. Once you have made these changes you can exit this file and save it.
  229.  
  230. ___________________________________________________________________________
  231.  
  232.                  FAQ.HTML
  233.                  ========
  234.  
  235. This file does not need to be edited, unless you want to change the 
  236. heading or title or add a link back to your wwwboard page.
  237.  
  238. It should be placed in the $basedir directory and its name should reflect 
  239. that of the $faq_file variable defined in wwwboard.pl
  240.  
  241. It should be chmoded 744, so that it is readable by all.
  242.  
  243. ___________________________________________________________________________
  244.  
  245.                    MESSAGES/
  246.                    =========
  247.  
  248. This is a directory that should also be placed in $basedir as defined in 
  249. wwwboard.pl.  This directory must be chmoded 777 so that messages can be 
  250. written into it by the server's UID.
  251.  
  252. ___________________________________________________________________________
  253.  
  254.                 DATA.TXT
  255.                 ========
  256.  
  257. Simply place this file into $basedir as defined in wwwboard.pl and chmod 
  258. it 777 so that the web server can write an incremented number to it.  
  259. This is where the file name number will be kept.
  260.  
  261. ___________________________________________________________________________
  262.  
  263.                  README
  264.                  ======
  265.  
  266.             This is the easiest.  Just READ it!
  267.  
  268. ___________________________________________________________________________
  269.  
  270. Version 2.0 Improvements Over 1.0:
  271.  
  272. * HTML does not mess up postings like the last version did.
  273. * There are many more options to allow flexibility in design.
  274. * One CGI program instead of three.  Makes everything smoother and
  275.   more efficient.
  276. * File names are derived from an incremented number up to 99999 so that
  277.   messages won't overlap, like they could have with the old pid numbers that
  278.   were used.
  279. * Many more things I can't even begin to list.
  280.  
  281. ___________________________________________________________________________
  282.  
  283. Version History:
  284.  
  285. Version 2.0:        Complete Re-Write of Version 1.0
  286.     11/4     -    ALPHA 1 Version Released because many people were 
  287.             writing asking if they could get a copy of it.
  288. ___________________________________________________________________________
  289.  
  290. As with all of my scripts which you can find at my scripts archive:
  291.  
  292. http://worldwidemart.com/scripts/
  293.  
  294. These are provided at no charge.  You can modify/edit/change/anything you 
  295. want to these scripts.  There are only two things that I ask, neither of 
  296. which will you be sued for if you don't follow.  :-)
  297.  
  298. 1)  Please let me know where these are being used  I like to see my work in
  299.     action.  you can let me know simply by filling out the on-line from
  300.     located at:       http://worldwidemart.com/scripts/implement.html
  301. 2)  Please keep my name somewhere in the script. It doesn't have to be
  302.     noticeable to users, but I appreciate it being in the script somewhere 
  303.     in case you ever pass it on or anything like that.
  304. 3)  Oh yah, there's a third one, but its the one I care least about.  I 
  305.     know how many people like to keep everyone at their own site and  
  306.     therefore do not link to the outside too often, but if at all possible, 
  307.     I would appreciate a link to my scripts archive.  Once again, this 
  308.     isn't necessary.
  309. 4)  Do the rules ever stop you say?  This last one is easy to follow:
  310.               ***HAVE FUN!***
  311.  
  312. ___________________________________________________________________________
  313. Matt Wright * mattw@worldwidemart.com * http://worldwidemart.com/scripts/
  314.